home *** CD-ROM | disk | FTP | other *** search
/ Aminet 15 / Aminet 15 - Nov 1996.iso / Aminet / dev / gcc / ixemsdk.lha / man / cat3 / gethostbyname.0 < prev    next >
Text File  |  1996-09-02  |  7KB  |  138 lines
  1.  
  2. GETHOSTBYNAME(3)           UNIX Programmer's Manual           GETHOSTBYNAME(3)
  3.  
  4. NNAAMMEE
  5.      ggeetthhoossttbbyynnaammee, ggeetthhoossttbbyyaaddddrr, ggeetthhoosstteenntt, sseetthhoosstteenntt, eennddhhoosstteenntt, hheerrrroorr
  6.      - get network host entry
  7.  
  8. SSYYNNOOPPSSIISS
  9.      ##iinncclluuddee <<nneettddbb..hh>>
  10.      eexxtteerrnn iinntt hh__eerrrrnnoo;;
  11.  
  12.      _s_t_r_u_c_t _h_o_s_t_e_n_t _*
  13.      ggeetthhoossttbbyynnaammee(_c_o_n_s_t _c_h_a_r _*_n_a_m_e)
  14.  
  15.      _s_t_r_u_c_t _h_o_s_t_e_n_t _*
  16.      ggeetthhoossttbbyyaaddddrr(_c_o_n_s_t _c_h_a_r _*_a_d_d_r, _i_n_t _l_e_n, _i_n_t _t_y_p_e)
  17.  
  18.      _s_t_r_u_c_t _h_o_s_t_e_n_t _*
  19.      ggeetthhoosstteenntt(_v_o_i_d)
  20.  
  21.      sseetthhoosstteenntt(_i_n_t _s_t_a_y_o_p_e_n)
  22.  
  23.      eennddhhoosstteenntt(_v_o_i_d)
  24.  
  25.      hheerrrroorr(_c_h_a_r _*_s_t_r_i_n_g)
  26.  
  27. DDEESSCCRRIIPPTTIIOONN
  28.      The ggeetthhoossttbbyynnaammee() and ggeetthhoossttbbyyaaddddrr() functions each return a pointer
  29.      to an object with the following structure describing an internet host
  30.      referenced by name or by address, respectively.  This structure contains
  31.      either the information obtained from the name server, named(8),  broken-
  32.      out fields from a line in _/_e_t_c_/_h_o_s_t_s, or database entries supplied by the
  33.      yp(8) system .  If the local name server is not running these routines do
  34.      a lookup in _/_e_t_c_/_h_o_s_t_s.
  35.  
  36.      struct  hostent {
  37.              char    *h_name;        /* official name of host */
  38.              char    **h_aliases;    /* alias list */
  39.              int     h_addrtype;     /* host address type */
  40.              int     h_length;       /* length of address */
  41.              char    **h_addr_list;  /* list of addresses from name server */
  42.      };
  43.      #define h_addr  h_addr_list[0]  /* address, for backward compatibility */
  44.  
  45.      The members of this structure are:
  46.  
  47.      _h___n_a_m_e       Official name of the host.
  48.  
  49.      _h___a_l_i_a_s_e_s    A zero terminated array of alternate names for the host.
  50.  
  51.      _h___a_d_d_r_t_y_p_e   The type of address being returned; currently always
  52.                   AF_INET.
  53.  
  54.      _h___l_e_n_g_t_h     The length, in bytes, of the address.
  55.  
  56.      _h___a_d_d_r___l_i_s_t  A zero terminated array of network addresses for the host.
  57.                   Host addresses are returned in network byte order.
  58.  
  59.      _h___a_d_d_r       The first address in _h___a_d_d_r___l_i_s_t; this is for backward com-
  60.                   patibility.
  61.  
  62.                   When using the nameserver, ggeetthhoossttbbyynnaammee() will search for
  63.                   the named host in the current domain and its parents unless
  64.                   the name ends in a dot.  If the name contains no dot, and if
  65.                   the environment variable ``HOSTALIASES'' contains the name
  66.                   of an alias file, the alias file will first be searched for
  67.                   an alias matching the input name.  See hostname(7) for the
  68.                   domain search procedure and the alias file format.
  69.  
  70.                   The sseetthhoosstteenntt() function may be used to request the use of
  71.                   a connected TCP socket for queries.  If the _s_t_a_y_o_p_e_n flag is
  72.                   non-zero, this sets the option to send all queries to the
  73.                   name server using TCP and to retain the connection after
  74.                   each call to ggeetthhoossttbbyynnaammee() or ggeetthhoossttbbyyaaddddrr().  Otherwise,
  75.                   queries are performed using UDP datagrams.
  76.  
  77.                   The eennddhhoosstteenntt() function closes the TCP connection.
  78.  
  79. FFIILLEESS
  80.      /etc/hosts
  81.  
  82. DDIIAAGGNNOOSSTTIICCSS
  83.      Error return status from ggeetthhoossttbbyynnaammee() and ggeetthhoossttbbyyaaddddrr() is indicated
  84.      by return of a null pointer.  The external integer _h___e_r_r_n_o may then be
  85.      checked to see whether this is a temporary failure or an invalid or un-
  86.      known host.  The routine hheerrrroorr() can be used to print an error message
  87.      describing the failure.  If its argument _s_t_r_i_n_g is non-NULL, it is print-
  88.      ed, followed by a colon and a space.  The error message is printed with a
  89.      trailing newline.
  90.  
  91.      The variable _h___e_r_r_n_o can have the following values:
  92.  
  93.      HOST_NOT_FOUND  No such host is known.
  94.  
  95.      TRY_AGAIN       This is usually a temporary error and means that the lo-
  96.                      cal server did not receive a response from an authorita-
  97.                      tive server.  A retry at some later time may succeed.
  98.  
  99.      NO_RECOVERY     Some unexpected server failure was encountered.  This is
  100.                      a non-recoverable error.
  101.  
  102.      NO_DATA         The requested name is valid but does not have an IP ad-
  103.                      dress; this is not a temporary error.  This means that
  104.                      the name is known to the name server but there is no ad-
  105.                      dress associated with this name.  Another type of request
  106.                      to the name server using this domain name will result in
  107.                      an answer; for example, a mail-forwarder may be regis-
  108.                      tered for this domain.
  109.  
  110. SSEEEE AALLSSOO
  111.      resolver(3),  hosts(5),  hostname(7),  named(8)
  112.  
  113. CCAAVVEEAATT
  114.      The ggeetthhoosstteenntt() function is defined, and sseetthhoosstteenntt() and eennddhhoosstteenntt()
  115.      are redefined, when libc(3) is built to use only the routines to lookup
  116.      in _/_e_t_c_/_h_o_s_t_s and not the name server.
  117.  
  118.      The ggeetthhoosstteenntt() function reads the next line of _/_e_t_c_/_h_o_s_t_s, opening the
  119.      file if necessary.
  120.  
  121.      The sseetthhoosstteenntt() function opens and/or rewinds the file _/_e_t_c_/_h_o_s_t_s. If
  122.      the _s_t_a_y_o_p_e_n argument is non-zero, the file will not be closed after each
  123.      call to ggeetthhoossttbbyynnaammee() or ggeetthhoossttbbyyaaddddrr().
  124.  
  125.      The eennddhhoosstteenntt() function closes the file.
  126.  
  127. HHIISSTTOORRYY
  128.      The hheerrrroorr() function appeared in 4.3BSD. The eennddhhoosstteenntt(),
  129.      ggeetthhoossttbbyyaaddddrr(), ggeetthhoossttbbyynnaammee(), ggeetthhoosstteenntt(), and sseetthhoosstteenntt() func-
  130.      tions appeared in 4.2BSD.
  131.  
  132. BBUUGGSS
  133.      These functions use static data storage; if the data is needed for future
  134.      use, it should be copied before any subsequent calls overwrite it.  Only
  135.      the Internet address format is currently understood.
  136.  
  137. 4.2 Berkeley Distribution       April 19, 1994                               3
  138.